Schema Changes from V7.1 through V8.0

The table below specifies elements added in schema versions 7.1, 7.2, 7.3, and 8.0

TABLE 1-5 New Elements V7.1 to V8.0

New Element

Parent of

Child of

Comments

url

 

customBilling

 

enhancedAuthResponse

fundingSource affluence

authorizationResponse

saleResponse

Consult your Relationship Manager before using.

fundingSource

type

availableBalance

enhancedAuthResponse

Parent of Enhanced Auth information

affluence

 

enhancedAuthResponse

Enum Values:

AFFLUENT

MASS AFFLUENT

type

 

fundingSource

Enum Values:

UNKNOWN

PREPAID

FSA

CREDIT (not used)

DEBIT (not used)

token

litleToken

expDate cardValidationNum

authorization

captureGivenAuth

credit

forceCapture

sale

Parent of token information

registerTokenRequest

orderId accountNumber

litleOnlineResponse

batchResponse

Request for token to replace card number

registerTokenResponse

litleTxnId

orderId

litleToken

bin

type

response

message

responseTime

litleOnlineRequest

batchRequest

Response for request for token to replace card number

litleToken

 

registerTokenResponse

The token used to replace the card account number.

bin

 

registerTokenResponse

tokenResponse

Provides BIN info when tokens are generated

tokenResponse

litleToken tokenResponseCode tokenMessage

type

bin

authorizationResponse

captureGivenAuthResponse

forceCaptureResponse

saleResponse

Provides token for tokenized merchants submitting card number in transaction requests

healthcareIIAS

healthcareAmounts

IIASFlag

authorization

sale

Used to provide details of Healthcare amounts

healthcareAmounts

totalHealthcareAmount

RxAmount

visionAmount

clinicOtherAmount

dentalAmount

healthcareIIAS

Used to provide details of Healthcare amounts

IIASFlag

 

healthcareIIAS

Must be set to true for Healthcare transactions

totalHealthcareAmount

 

healthcareAmounts

Total of healthcare amounts.

RxAmount

 

healthcareAmounts

Prescription component of healthcare amounts.

visionAmount

 

healthcareAmounts

Vision component of healthcare amounts.

clinicOtherAmount

 

healthcareAmounts

Clinic/other component of healthcare amounts.

dentalAmount

 

healthcareAmounts

Dental component of healthcare amounts.

firstName

 

billToAddress

used for eCheck Verification

middleInitial

 

billToAddress

used for eCheck Verification

lastName

 

billToAddress

used for eCheck Verification

companyName

 

billToAddress

used for eCheck Verification

advancedAVSResults

 

fraudResult

American Express AVS for email and phone

accountUpdater

originalAccountInfo

newAccountInfo

echeckSalesResponse

echeckCreditResponse

echeckVerificationResponse

Used to provide info about automatic NOC updates

originalAccountInfo

accType

accNumroutingNum

accountUpdater

Used to provide info about automatic NOC updates

newAccountInfo

accType

accNum

routingNum

accountUpdater

Used to provide info about automatic NOC updates

merchantData

campaign

affiliate merchantGroupingId

authorization

captureGivenAuth

credit

forceCapture

sale

eCheckSale

eCheckCredit

Note: The transaction tracking feature was added in October 2011 without a revision to the schema version. If you coded to V7.3 (or any 7.x version) prior to October 2011, you must modify your coding to take advantage of this feature.

campaign

 

merchantData

Used to sort transactions by marketing campaign

affiliate

 

merchantData

Used to sort transactions by affiliate sales

merchantGroupingId

 

merchantData

Used to sort transactions by merchant designated values

recyclingRequest

recycleBy

recycleId (added in February 2012)

authorization

sale

Note: This control and its child was added in December 2011 without a revision to the schema version. If you coded to V7.3 (or any 7.x version) prior to December 2011, you must modify your coding to take advantage of this control.

recycleBy

 

recyclingRequest

Used to indicate who merchant or Worldpay) controls recycling of the transaction should it be declined. Also determines where the transaction is counted for the purposes of A/B testing.

recycleId

 

recyclingRequest

Can be used as an alternate to <orderId> in the recycling signature.

Note: This identifier was added to V7.3 in February 2012 without a revision to the schema version. If you coded to V7.3 prior to February 2012, you must modify your coding to take advantage of this element.

recycling

recycleEngineActive (added in February 2012)

authorizationResponse

saleResponse

 

recycleEngineActive

 

recycling

Note: This flag was added to V7.3 in February 2012 without a revision to the schema version. If you coded to V7.3 prior to February 2012, you must modify your coding to take advantage of this element.

recycling

creditLitleTxnId

voidResponse

Contains a child element providing the Vantiv transaction Id of an associated credit transaction (see below).

Note: This element was added to V7.3 in January 2013 without a revision to the schema version. If you coded to V7.3 prior to January 2013, you must modify your coding to take advantage of this element.

creditLitleTxnId

 

recycling

The Vantiv transaction Id of the credit transaction automatically issued by the system when you use a Void transaction to halt the Recycling Engine, but the transaction is already approved and captured. (Auto-refund option must be enabled.)

 

Other schema changes:

  • Beginning with cnpAPI schema version 7 response messages no longer include the xmlns attribute.

  • Added new enumeration, FSA, as a a possible response (value) for the type element, when type is a child of fundingSource.

  • All parents of the token element allow a choice between either card and token, or card, token, and paypal.